home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 7: Sunsite / Linux Cubed Series 7 - Sunsite Vol 1.iso / system / mail / imapperl.6 / imapperl / imap / README < prev   
Text File  |  1996-02-04  |  3KB  |  92 lines
  1.  
  2.  
  3.                        IMAP2bis Perl5 Functions
  4.                         and Client Application
  5.  
  6.                              R. Kooijman
  7.  
  8.                              Version 0.6
  9.  
  10.  
  11.  
  12. I needed software for a popclient-like mail retrieval application using
  13. IMAP2bis. I could not use popclient since I have more than one mailbox
  14. on my accounts and sometimes want to leave messages at the original
  15. sites (possibly flagged), plus we are running an IMAP server anyway (the
  16. one made by the University of Washington). 
  17.  
  18. So I started reading RFC1176 and the C-client library software by Mark
  19. Crispin. Foolishly enough, I decided to make my own software in Perl.
  20. The target application eventually will be a mail message synchronizer,
  21. but to do mailbox synchronisation reliably you need an IMAP4 server. 
  22.  
  23. The current version enables you to download unseen messages and leave
  24. them as they are (but seen) on the server, remove them, or flag them
  25. as important and possibly unseen again.
  26.  
  27. The provided library functions enable you to program IMAP client
  28. software in Perl 5. I did not implement all IMAP2bis commands, only the
  29. most important ones, but there is enough support for the provided
  30. IMAP2bis mail downloader. The framework can be extended quite easily I
  31. think, and I will do that myself as soon as the IMAP4 server of the
  32. University of Washington comes out (and I canfind the time to make a
  33. real mailbox synchronizer for disconnected use).
  34.  
  35. One drawback of the supplied client application is that it uses procmail
  36. as a delivery agent. I didn't make that configurable, but I am sure
  37. knowledgeable people can change the application quite easily to use
  38. other local delivery agents. Search for 'open(FORMAIL' around line 205.
  39. The suggestion you find there for Linux should work too (not tested!).
  40. Well, as I said knowledgeable people will get the idea.
  41.  
  42. You have to examine the client application and the sources for
  43. information on how to use the library routines but I can give an
  44. overview of the command-line arguments (defaults are between brackets):
  45.  
  46.     imapsync -bdinqrx -e efficiency -h host -l limit -p port -t timeout -u user
  47.  
  48.         -b  retrieve BODY[1] instead of RFC822.TEXT
  49.         -d  debug mode (off)
  50.         -e    efficiency setting, retrieve mail in batches (10)
  51.         -h  specify IMAP host (localhost)
  52.         -i  flag retrieved messages as important (off)
  53.         -l  only retrieve messages smaller than specified value (off)
  54.         -n  flag retrieved messages as new (off)
  55.         -p  specify IMAP port (143)
  56.         -q  quiet mode (off)
  57.         -r  delete retrieved messages (off)
  58.         -t  place timeout on reading lines (off)
  59.         -u  use another name to login (logged on user)
  60.         -x    expunge regularly after each batch of messages (off)
  61.  
  62.  
  63. Requirements:
  64.  
  65.     - Perl 5
  66.     - procmail (used as a delivery agent in main application but
  67.                 this can be changed)
  68.     - basically a UNIX OS that runs Perl 5 and procmail (or a mail
  69.                 delivery agent you can use)
  70.  
  71.  
  72. Installation:
  73.  
  74.     - install msg.pl and imap.pl in a directory that is searched for
  75.         Perl libraries,
  76.     - install imapsync in a directory that is in your search path,
  77.     - edit a file in your home directory called .imapsyncrc and
  78.         place the mailboxes in there which you want to be
  79.         scanned for unseen messages.
  80.  
  81.  
  82. License:
  83.  
  84.     Public domain, but I appreciate it if you credit my name in any
  85.     products you derive from this software.
  86.  
  87.  
  88. Disclaimer:
  89.  
  90.     This software is provided as-is. You can not hold me responsible 
  91.     for any damage to your mail.
  92.